<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: datagram_pair.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('datagram__pair_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">datagram_pair.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT datagram pair structure.  
<a href="#details">More...</a></p>

<p><a href="datagram__pair_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Domain datagram pair.  <a href="structec__datagram__pair__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad68c9cbef047c62f692646025db09f80"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="datagram__pair_8h.html#ad68c9cbef047c62f692646025db09f80">ec_datagram_pair_init</a> (<a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a> *, <a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *, uint32_t, uint8_t *, size_t, const unsigned int [])</td></tr>
<tr class="memdesc:ad68c9cbef047c62f692646025db09f80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Datagram pair constructor.  <a href="#ad68c9cbef047c62f692646025db09f80">More...</a><br /></td></tr>
<tr class="separator:ad68c9cbef047c62f692646025db09f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3ff7374f362ab7e2990346186202b71"><td class="memItemLeft" align="right" valign="top"><a id="ac3ff7374f362ab7e2990346186202b71"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="datagram__pair_8h.html#ac3ff7374f362ab7e2990346186202b71">ec_datagram_pair_clear</a> (<a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a> *)</td></tr>
<tr class="memdesc:ac3ff7374f362ab7e2990346186202b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Datagram pair destructor. <br /></td></tr>
<tr class="separator:ac3ff7374f362ab7e2990346186202b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58f5dc413c70031fda65e18fe696682b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="datagram__pair_8h.html#a58f5dc413c70031fda65e18fe696682b">ec_datagram_pair_process</a> (<a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a> *, uint16_t[])</td></tr>
<tr class="memdesc:a58f5dc413c70031fda65e18fe696682b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process received data.  <a href="#a58f5dc413c70031fda65e18fe696682b">More...</a><br /></td></tr>
<tr class="separator:a58f5dc413c70031fda65e18fe696682b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT datagram pair structure. </p>

<p class="definition">Definition in file <a class="el" href="datagram__pair_8h_source.html">datagram_pair.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ad68c9cbef047c62f692646025db09f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad68c9cbef047c62f692646025db09f80">&#9670;&nbsp;</a></span>ec_datagram_pair_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_datagram_pair_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a> *&#160;</td>
          <td class="paramname"><em>pair</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *&#160;</td>
          <td class="paramname"><em>domain</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>logical_offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>data_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned int&#160;</td>
          <td class="paramname"><em>used</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Datagram pair constructor. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pair</td><td>Datagram pair. </td></tr>
    <tr><td class="paramname">domain</td><td>Parent domain. </td></tr>
    <tr><td class="paramname">logical_offset</td><td>Logical offset. </td></tr>
    <tr><td class="paramname">data</td><td>Data pointer. </td></tr>
    <tr><td class="paramname">data_size</td><td>Data size. </td></tr>
    <tr><td class="paramname">used</td><td>input/output use count. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="datagram__pair_8c_source.html#l00048">48</a> of file <a class="el" href="datagram__pair_8c_source.html">datagram_pair.c</a>.</p>

</div>
</div>
<a id="a58f5dc413c70031fda65e18fe696682b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58f5dc413c70031fda65e18fe696682b">&#9670;&nbsp;</a></span>ec_datagram_pair_process()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t ec_datagram_pair_process </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__datagram__pair__t.html">ec_datagram_pair_t</a> *&#160;</td>
          <td class="paramname"><em>pair</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>wc_sum</em>[]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Process received data. </p>
<dl class="section return"><dt>Returns</dt><dd>Working counter sum over all devices. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pair</td><td>Datagram pair. </td></tr>
    <tr><td class="paramname">wc_sum</td><td>Working counter sums. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="datagram__pair_8c_source.html#l00176">176</a> of file <a class="el" href="datagram__pair_8c_source.html">datagram_pair.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="datagram__pair_8h.html">datagram_pair.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
